Loan Information
This endpoint returns all loans or all loans associated with given customer. Authorization is required.
HTTP REQUEST
Development
GET: https://dev.vendorintegration.growersedge.com/LoanInformation
GET: https://dev.vendorintegration.growersedge.com/LoanInformation/{customerId}
Production
GET: https://vendorintegration.growersedge.com/LoanInformation
GET: https://vendorintegration.growersedge.com/LoanInformation/{customerId}
Responses
Code | Description |
---|---|
200 | Success |
500 | Internal Server Error |
401 | Unauthorized |
502 | Bad Gateway |
Path Parameters
Property Name | Type | Required |
---|---|---|
customerId | string | No |
Successful Response
Response will be an array of the following object:
Property Name | Type | Nullable |
---|---|---|
loanFirstName | string | true |
loanLastName | string | true |
loanNumber | integer | true |
loanType | string | true |
loanStatus | string | true |
loanCommitment | double | false |
availableCredit | double | false |
currentLoanBalance | double | false |
ltdFees | double | false |
maturityDate | string(date-time) | false |
dailyPayoffAmount | double | false |
thirdPartyCustomerId | string | true |
partnerIdentifier | int | true |
interestRate | double | false |
dailyInterest | double | false |
canMakeDrawRequests | boolean | false |
Loan Status
Loan Status is a calculated field with following possible values.
Loan Status Values |
---|
Ready To Use |
Transaction Pending |
No More Available Credit |
Paid in Full |
Past Due |
Unknown |
Examples
Python:
from azure.identity import CertificateCredential
import requests
TENANT_ID = '***'
CLIENT_ID = '***'
CLIENT_SECRET = '***'
CLIENT_SCOPE = '***'
API_URL = 'https://vendorintegration.growersedge.com/LoanInformation/{growerId}'
def getPartnerLoans( token : str, growerId : str ):
partnerLoansResponse = requests.get(
API_URL.format( growerId = growerId ),
headers = { 'Authorization' : f'Bearer {token}'}
)
if( partnerLoansResponse.status_code == 200 ):
content = partnerLoansResponse.json()
return content;
else:
raise( Exception( 'API Call failed.' ) )
def main():
credential = ClientSecretCredential( TENANT_ID, CLIENT_ID, CLIENT_SECRET )
access_token = credential.get_token( CLIENT_SCOPE )
print( getPartnerLoans( access_token.token, 249991 ) )
if __name__ == '__main__':
main()
curl --request GET \
--url https://vendorintegration.growersedge.com/LoanInformation/ \
--header 'Authorization: Bearer <INSERT YOUR TOKEN>'